| Description |
:
The `Get Search Fuzzy` (**Free Form Search**) API, an HTTP `GET` request that seamlessly handles a combination of [POI search](/rest/api/maps/search/get-search-poi?view=rest-maps-1.0) and [geocoding](/rest/api/maps/search/get-search-address?view=rest-maps-1.0). It is a Free Form Search API which handles fuzzy of inputs containing any combination of address or POI tokens as a canonical 'single line search'. It can also be weighted with a contextual position (lat/lon pair), or fully constrained by a coordinate and radius, or it can be executed more generally without any geo biasing anchor point. We strongly advise you to use the 'countrySet' parameter to specify only the countries/regions for which your application needs coverage, as the default behavior will be to search the entire world, potentially returning unnecessary results. E.g.: `countrySet`=US,FR Please see [Search Coverage](/azure/location-based-services/geocoding-coverage) for a complete list of all the supported countries/regions. Most Search queries default to `maxFuzzyLevel`=2 to gain performance and also reduce unusual results. This new default can be overridden as needed per request by passing in the query param `maxFuzzyLevel`=3 or 4. |
| Reference | : Link ¶ |
⚶ Changes
{
"#id": "Search_GetSearchFuzzy",
"$responses": {
"200": {
"$properties": {
"results": {
"$properties": {
"address": [
{
"#name": "buildingNumber",
"Description": {
"new": "The building number on the street.\n**Important**: This property is *deprecated*. Use `streetNumber` instead.",
"old": "The building number on the street. DEPRECATED, use streetNumber instead."
}
},
{
"#name": "street",
"Description": {
"new": "The street name.\n**Important**: This property is *deprecated*. Use `streetName` instead.",
"old": "The street name. DEPRECATED, use streetName instead."
}
},
{
"#name": "streetNameAndNumber",
"Description": {
"new": "The street name and number.\nOnly available for the Search Address Reverse APIs.",
"old": "The street name and number."
}
}
]
}
}
}
}
}
}
⚼ Request
GET:
/search/fuzzy/{format}
{
x-ms-client-id:
string
,
api-version:
string
,
format:
string
,
query:
string
,
typeahead:
boolean
,
limit:
integer
,
ofs:
integer
,
categorySet:
array
,
countrySet:
array
,
lat:
number
,
lon:
number
,
radius:
integer
,
topLeft:
string
,
btmRight:
string
,
language:
string
,
extendedPostalCodesFor:
array
,
minFuzzyLevel:
integer
,
maxFuzzyLevel:
integer
,
idxSet:
array
,
brandSet:
array
,
connectorSet:
array
,
entityType:
string
,
view:
string
,
openingHours:
string
,
}
⚐ Response (200)
{
summary:
{
,
query:
string
,
queryType:
enum
,
queryTime:
integer
,
numResults:
integer
,
limit:
integer
,
offset:
integer
,
totalResults:
integer
,
fuzzyLevel:
integer
,
geoBias:
}
{
,
lat:
number
,
lon:
number
,
}
results:
}
[
]
,
{
,
type:
enum
,
id:
string
,
score:
number
,
dist:
number
,
info:
string
,
entityType:
enum
,
poi:
{
,
name:
string
,
phone:
string
,
url:
string
,
categorySet:
[
]
,
{
,
id:
integer
,
}
categories:
[
,
string
,
]
classifications:
[
]
,
{
,
code:
string
,
names:
}
[
]
,
{
,
nameLocale:
string
,
name:
string
,
}
brands:
[
]
,
{
,
name:
string
,
}
openingHours:
}
{
,
mode:
string
,
timeRanges:
}
[
]
,
{
,
startTime:
{
,
date:
string
,
hour:
integer
,
minute:
integer
,
}
endTime:
}
{
,
date:
string
,
hour:
integer
,
minute:
integer
,
}
address:
{
,
buildingNumber:
string
,
street:
string
,
crossStreet:
string
,
streetNumber:
string
,
routeNumbers:
[
,
string
,
]
streetName:
string
,
streetNameAndNumber:
string
,
neighbourhood:
string
,
municipality:
string
,
municipalitySubdivision:
string
,
countrySubdivision:
string
,
countrySubdivisionCode:
string
,
countryTertiarySubdivision:
string
,
countrySecondarySubdivision:
string
,
postalCode:
string
,
extendedPostalCode:
string
,
countryCode:
string
,
country:
string
,
countryCodeISO3:
string
,
freeformAddress:
string
,
countrySubdivisionName:
string
,
localName:
string
,
boundingBox:
}
{
,
northEast:
string
,
southWest:
string
,
entity:
enum
,
}
position:
{
,
lat:
number
,
lon:
number
,
}
viewport:
{
,
topLeftPoint:
{
,
lat:
number
,
lon:
number
,
}
btmRightPoint:
}
{
,
lat:
number
,
lon:
number
,
}
entryPoints:
[
]
,
{
,
type:
enum
,
position:
}
{
,
lat:
number
,
lon:
number
,
}
addressRanges:
{
,
rangeLeft:
string
,
rangeRight:
string
,
from:
{
,
lat:
number
,
lon:
number
,
}
to:
}
{
,
lat:
number
,
lon:
number
,
}
dataSources:
{
,
geometry:
}
{
,
id:
string
,
}
matchType:
enum
,
detourTime:
integer
,
}
⚐ Response (default)
{
error:
}
{
,
code:
string
,
message:
string
,
target:
string
,
details:
[
,
string
,
]
additionalInfo:
}
[
]
,
{
,
type:
string
,
info:
object
,
}